Summarizer: availability() statische Methode

Sicherer Kontext: Diese Funktion ist nur in sicheren Kontexten (HTTPS) in einigen oder allen unterstützenden Browsern verfügbar.

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig vor der Verwendung auf produktiven Webseiten.

Die availability() statische Methode der Summarizer Schnittstelle gibt einen enumerierten Wert zurück, der angibt, ob das AI-Modell des Browsers eine gegebene Summarizer-Konfiguration unterstützt (oder unterstützen wird).

Syntax

Summarizer.availability()
Summarizer.availability(options)

Parameter

options Optional

Ein Optionsobjekt, das eine mögliche Konfiguration für einen Summarizer spezifiziert. Mögliche Werte sind:

expectedInputLanguages: Ein Array von Strings, die BCP 47 Sprachcodes entsprechen (wie in RFC 5646 festgelegt), welches die erwarteten Sprachen des Eingabetexts angibt. Standardmäßig ["en"].
expectedContextLanguages: Ein Array von Strings, die BCP 47 Sprachcodes entsprechen und die erwarteten Sprachen der bereitgestellten Kontext-Strings angeben (entweder der sharedContext, der an den Summarizer übergeben wird, oder ein während eines summarize()- oder summarizeStreaming()-Aufrufs spezifizierter context). Standardmäßig ["en"].
format: Ein enumerierter Wert, der das Text-format angibt, in dem Sie Zusammenfassungen erhalten möchten. Standardmäßig markdown.
length: Ein enumerierter Wert, der die relative length für die generierten Zusammenfassungen angibt. Standardmäßig short.
outputLanguage: Ein String, der einem BCP 47 Sprachcode entspricht und die erwartete Sprache der vom Summarizer generierten Zusammenfassungen angibt. Standardmäßig en.
type: Ein enumerierter Wert, der den type der Zusammenfassung angibt, die dieser Summarizer generieren soll. Standardmäßig key-points.

Rückgabewert

Ein Promise, das mit einem enumerierten Wert erfüllt wird, der anzeigt, ob Unterstützung für eine gegebene Summarizer-Konfiguration verfügbar (oder verfügbar sein wird) ist, oder null, wenn die Unterstützung nicht festgestellt werden konnte.

Mögliche Werte sind:

available: Der Browser unterstützt die gegebene Konfiguration und kann sofort verwendet werden.
downloadable: Der Browser unterstützt die gegebene Konfiguration, muss jedoch zuerst ein AI-Modell oder einige Feinabstimmungsdaten für das Modell herunterladen.
downloading: Der Browser unterstützt die gegebene Konfiguration, muss jedoch einen laufenden Download abschließen, bevor er fortfahren kann.
unavailable: Der Browser unterstützt die gegebene Konfiguration nicht.

Ausnahmen

NotAllowedError DOMException: Wirft einen Fehler, wenn die Verwendung der Summarizer-API durch eine summarizer Permissions-Policy blockiert wird.
NotSupportedError DOMException: Wirft einen Fehler, wenn der bereitgestellte context nicht in einer Sprache ist, die der Summarizer unterstützt.
UnknownError DOMException: Wirft einen Fehler, wenn der measureInputUsage()-Aufruf aus einem anderen Grund fehlschlug oder aus einem Grund, den der Benutzeragent nicht bekannt geben wollte.

Beispiele

Grundlegende `availability()`-Nutzung

async function getSummarizer() {
  const options = {
    sharedContext: "This is a scientific article",
    type: "key-points",
    format: "markdown",
    length: "medium",
  };

  const availability = await Summarizer.availability(options);
  if (availability === "unavailable") {
    // The Summarizer API isn't usable
    return undefined;
  } else if (availability === "available") {
    // The Summarizer API can be used immediately
    return Summarizer.create(options);
  }
  // The Summarizer API can be used after the model is downloaded
  const summarizer = await Summarizer.create(options);
  summarizer.addEventListener("downloadprogress", (e) => {
    console.log(`Downloaded ${e.loaded * 100}%`);
  });
  return summarizer;
}

Erkennen der Sprachunterstützung

async function langSupport(lang) {
  const availability = await Summarizer.availability({
    expectedInputLanguages: [lang],
  });
  return availability;
}

langSupport("en-US");
langSupport("fr");
langSupport("zh-CN");

Spezifikationen

Specification
Writing Assistance APIs # dom-summarizer-availability

Browser-Kompatibilität

Siehe auch

Verwendung der Summarizer API
Web AI Demos auf chrome.dev